<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hdmirxss1: xhdmi_intr.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hdmirxss1
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xhdmi__intr_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xhdmi_intr.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file demonstrates application usage for EDID. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.00   GM     05/03/18 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a731d698315d4e42ef409c02517adb1a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__intr_8c.html#a731d698315d4e42ef409c02517adb1a7">XHdmi_InterruptInitialize</a> (void)</td></tr>
<tr class="memdesc:a731d698315d4e42ef409c02517adb1a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the HDMI ExDes interrupt queue variables.  <a href="#a731d698315d4e42ef409c02517adb1a7">More...</a><br/></td></tr>
<tr class="separator:a731d698315d4e42ef409c02517adb1a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ef77dda5ad72293a7ce47f2e6c9473e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__intr_8c.html#a7ef77dda5ad72293a7ce47f2e6c9473e">XHdmi_InterruptConnect</a> (void *Intc, u8 Id, XInterruptHandler Handler, void *CallBackRef)</td></tr>
<tr class="memdesc:a7ef77dda5ad72293a7ce47f2e6c9473e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes the connection between the Id of the interrupt source and the associated handler that is to run when the interrupt is recognized.  <a href="#a7ef77dda5ad72293a7ce47f2e6c9473e">More...</a><br/></td></tr>
<tr class="separator:a7ef77dda5ad72293a7ce47f2e6c9473e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae12fb37ee7f61694ad04c8c6dc8608b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__intr_8c.html#ae12fb37ee7f61694ad04c8c6dc8608b4">XHdmi_InterruptHandler</a> (void *CallBackRef)</td></tr>
<tr class="memdesc:ae12fb37ee7f61694ad04c8c6dc8608b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the HDMI ExDes.  <a href="#ae12fb37ee7f61694ad04c8c6dc8608b4">More...</a><br/></td></tr>
<tr class="separator:ae12fb37ee7f61694ad04c8c6dc8608b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef47e5e7451e69fe6631b6862eaf7bd5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__intr_8c.html#aef47e5e7451e69fe6631b6862eaf7bd5">XHdmi_InterruptService</a> (void)</td></tr>
<tr class="memdesc:aef47e5e7451e69fe6631b6862eaf7bd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function services the queued interrupts for the HDMI ExDes in the normal program flow (outside ISR).  <a href="#aef47e5e7451e69fe6631b6862eaf7bd5">More...</a><br/></td></tr>
<tr class="separator:aef47e5e7451e69fe6631b6862eaf7bd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d8787371982e56ea409730f3591a0ed"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__intr_8c.html#a5d8787371982e56ea409730f3591a0ed">XHdmi_InterruptDevIdLookUp</a> (void *CallBackRef)</td></tr>
<tr class="memdesc:a5d8787371982e56ea409730f3591a0ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will look for the interrupt device ID based on the Callback reference registered to it.  <a href="#a5d8787371982e56ea409730f3591a0ed">More...</a><br/></td></tr>
<tr class="separator:a5d8787371982e56ea409730f3591a0ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a7ef77dda5ad72293a7ce47f2e6c9473e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHdmi_InterruptConnect </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>Intc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XInterruptHandler&#160;</td>
          <td class="paramname"><em>Handler</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Makes the connection between the Id of the interrupt source and the associated handler that is to run when the interrupt is recognized. </p>
<p>It registers the CallBack reference and handler in the local interrupt handler table based in the DevID or interrupt bit position.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Intc</td><td>is a pointer to the INT controlerr instance to be worked on. </td></tr>
    <tr><td class="paramname">Id</td><td>contains the ID of the interrupt source and should be in the range of 0 to MAX_NUM_INTR_INPUTS - 1 with 0 being the highest priority interrupt. </td></tr>
    <tr><td class="paramname">Handler</td><td>to the handler for that interrupt. </td></tr>
    <tr><td class="paramname">CallBackRef</td><td>is the callback reference, usually the instance pointer of the connecting driver.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><pre class="fragment">            - XST_SUCCESS if the handler was connected correctly.
</pre></dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>WARNING: The handler provided as an argument will overwrite any handler that was previously connected. </p>

<p>References <a class="el" href="xhdmi__intr_8c.html#ae12fb37ee7f61694ad04c8c6dc8608b4">XHdmi_InterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a5d8787371982e56ea409730f3591a0ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHdmi_InterruptDevIdLookUp </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will look for the interrupt device ID based on the Callback reference registered to it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a pointer to the XHdmi_HandlerTable instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Interrupt Device ID</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xhdmi__intr_8c.html#ae12fb37ee7f61694ad04c8c6dc8608b4">XHdmi_InterruptHandler()</a>, and <a class="el" href="xhdmi__intr_8c.html#aef47e5e7451e69fe6631b6862eaf7bd5">XHdmi_InterruptService()</a>.</p>

</div>
</div>
<a class="anchor" id="ae12fb37ee7f61694ad04c8c6dc8608b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_InterruptHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the HDMI ExDes. </p>
<p>It will will register the CallBackRef in the tail of the interrupt queue and will disable the interrupt position to prevent interrupt storm.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is the callback reference register in the interrupt controller.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xhdmi__intr_8c.html#a5d8787371982e56ea409730f3591a0ed">XHdmi_InterruptDevIdLookUp()</a>.</p>

<p>Referenced by <a class="el" href="xhdmi__intr_8c.html#a7ef77dda5ad72293a7ce47f2e6c9473e">XHdmi_InterruptConnect()</a>.</p>

</div>
</div>
<a class="anchor" id="a731d698315d4e42ef409c02517adb1a7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_InterruptInitialize </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the HDMI ExDes interrupt queue variables. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="aef47e5e7451e69fe6631b6862eaf7bd5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_InterruptService </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function services the queued interrupts for the HDMI ExDes in the normal program flow (outside ISR). </p>
<p>It will invoke the appropriate callback for the corresponding interrupt and will re-enable the interrupt bit in the INT controller after servicing.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xhdmi__intr_8c.html#a5d8787371982e56ea409730f3591a0ed">XHdmi_InterruptDevIdLookUp()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
